[clang] Improve make_cxx_dr_status behavior when error occurs
#121785
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
|
@llvm/pr-subscribers-clang Author: Vlad Serebrennikov (Endilll) ChangesOne of our contributors got confused by the behavior of the script when they incorrectly specified the status of a CWG issue (https://github.com/llvm/llvm-project/pull/102857/files#r1904264872), and this is an attempt to reduce the confusion:
Full diff: https://github.com/llvm/llvm-project/pull/121785.diff 1 Files Affected:
diff --git a/clang/www/make_cxx_dr_status b/clang/www/make_cxx_dr_status
index e0885fdbd2d3c2..05de96119fc18a 100755
--- a/clang/www/make_cxx_dr_status
+++ b/clang/www/make_cxx_dr_status
@@ -83,8 +83,8 @@ else:
status_map = collect_tests()
drs = get_issues(issue_list_path)
-out_file = open(output, 'w')
-out_file.write('''\
+out_html = []
+out_html.append('''\
<!DOCTYPE html>
<!-- This file is auto-generated by make_cxx_dr_status. Do not modify. -->
<html>
@@ -149,7 +149,7 @@ def availability(issue):
unresolved_status = unresolved_status_match.group(1)
proposed_resolution_match = re.search(r' (open|drafting|review|tentatively ready|ready) (\d{4}-\d{2}(?:-\d{2})?|P\d{4}R\d+)$', status)
if proposed_resolution_match is None:
- raise AvailabilityError('Issue {}: \'{}\' status should be followed by a paper number (P1234R5) or proposed resolution in YYYY-MM-DD format'.format(dr.issue, unresolved_status))
+ raise AvailabilityError('error: issue {}: \'{}\' status should be followed by a paper number (P1234R5) or proposed resolution in YYYY-MM-DD format'.format(dr.issue, unresolved_status))
proposed_resolution = proposed_resolution_match.group(2)
status = status[:-1-len(proposed_resolution)]
status = status[:-1-len(unresolved_status)]
@@ -236,7 +236,7 @@ def availability(issue):
avail = 'Duplicate of <a href="#%s">%s</a>' % (dup, dup)
_, avail_style, _, _ = availability(dup)
else:
- raise AvailabilityError('Unknown status %s for issue %s' % (status, dr.issue))
+ raise AvailabilityError('error: unknown status %s for issue %s' % (status, dr.issue))
return (avail + avail_suffix, avail_style, unresolved_status, details)
count = {}
@@ -266,7 +266,7 @@ for dr in drs:
else:
if unresolved_status != dr.status:
availability_error_occurred = True
- print("Issue %s is marked '%s', which differs from CWG index status '%s'" \
+ print("error: issue %s is marked '%s', which differs from CWG index status '%s'" \
% (dr.issue, unresolved_status, dr.status))
continue
else:
@@ -280,7 +280,7 @@ for dr in drs:
if unresolved_status:
availability_error_occurred = True
- print("Issue %s is marked '%s', even though it is resolved in CWG index" \
+ print("error: issue %s is marked '%s', even though it is resolved in CWG index" \
% (dr.issue, unresolved_status))
continue
@@ -296,7 +296,7 @@ for dr in drs:
<summary>{avail}</summary>
{details}
</details>'''
- out_file.write(f'''
+ out_html.append(f'''
<tr{row_style} id="{dr.issue}">
<td><a href="https://cplusplus.github.io/CWG/issues/{dr.issue}.html">{dr.issue}</a></td>
<td>{dr.status}</td>
@@ -310,12 +310,14 @@ if availability_error_occurred:
for status, num in sorted(count.items()):
print("%s: %s" % (status, num), file=sys.stderr)
-out_file.write('''\
+out_html.append('''\
</table>
</div>
</body>
</html>
''')
-out_file.close()
+out_file = open(output, 'w')
+out_file.write(''.join(out_html))
+out_file.close()
|
cor3ntin
approved these changes
Jan 6, 2025
zyn0217
approved these changes
Jan 6, 2025
Contributor
zyn0217
left a comment
zyn0217
left a comment
There was a problem hiding this comment.
Thanks, the patch looks great
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
One of our contributors got confused by the behavior of the script when they incorrectly specified the status of a CWG issue (https://github.com/llvm/llvm-project/pull/102857/files#r1904264872), and this is an attempt to reduce the confusion:
error:to make it more obvious that a fatal error occurred.